<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8"/>
<link rel="stylesheet" type="text/css" href="dmsstyle.css" />
<title>The dmp.server Schema</title>
</head>

<body>

  <div id="header"> <div class="headerBar"> </div> </div>

  <div id="main">

    <div id="content">

  <div class="schemaName"> dmp.server </div>

  <div class="summary">

    <div class="classList">
    <h2> Classes (5)</h2>
    <table>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#PluginConfig"> PluginConfig </a></td>
      <td> camelCaseName </td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#SessionFolderRI"> SessionFolderRI </a></td>
      <td> dotName (H) </td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#SessionRI"> SessionRI </a></td>
      <td> dotName (H) </td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#UserFolderRI"> UserFolderRI </a></td>
      <td> dotName (H) </td>
      </tr>
      <tr>
      <td class="spacer"> </td>
      <td> <a class="deflink" href="#UserRI"> UserRI </a></td>
      <td> dotName (H) </td>
      </tr>
    </table>
    </div><div class="hierarchy">

<h2> Instance Hierarchy </h2>

        <div class="hier0"> <a class="deflink" href="#SessionFolderRI"> SessionFolderRI </a> </div>

        <div class="hier1"> <a class="deflink" href="#SessionRI"> SessionRI </a> </div>

        <div class="hier0"> <a class="deflink" href="#UserFolderRI"> UserFolderRI </a> </div>

        <div class="hier1"> <a class="deflink" href="#UserRI"> UserRI </a> </div>

</div> <!-- hierarchy -->

<p />
  </div> <!--  summary -->

<div class="classDetails">

<h2> Class Details </h2>

  <table>

    <tr> <td class="className" colspan="4"> <a name="PluginConfig"> PluginConfig </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The PluginConfig is used to specify a plugin to be loaded into the DMP Servlet Reference Implementation servlet.</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">STRUCTURAL</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Wrapper</td>
      <td colspan="2">EXTENDED</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Named by</td>
      <td colspan="2"> <a href="meta.html#camelCaseName">camelCaseName</a> </td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Must</td>
      <td> <a href="meta.html#camelCaseName">camelCaseName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#CamelCaseName">CamelCaseName</a> </td>
      <td> The camelCaseName attribute is used to store a single camelCase format name for something. The name starts with a single letter and can be followed by a mix of letters and numbers. No spaces or  other characters are allowed. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmp.server.html#pluginClass">pluginClass</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> The fully qualified name of the class derived from DmpServletPlugin that implements a plugin's behaviour. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmp.server.html#pluginName">pluginName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#CamelCaseName">CamelCaseName</a> </td>
      <td> The globally unique name of a Dark Matter ServletPlugin. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">May</td>
      <td> <a href="meta.html#description">description</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> The description attribute is used to provide descriptive documentation for schema related definitions. The description is of type XHMTLString which is basically an XML formatted fragment that conforms to the XHTML 1.0 specification. For more information, see the DmdTypeDef for XHTMLString. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmp.server.html#runnable">runnable</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#Boolean">Boolean</a> </td>
      <td> A flag to indicate if a plugin implements Runnable. If so, once all plugins have been initialized, the runnable plugins will be started. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmp.server.html#startOrder">startOrder</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#Integer">Integer</a> </td>
      <td> The order in which the plugins should be initialized and started. If no order is specified, we default to 5. If a plugin depends on data provided by another  plugin, it should have a later startOrder than the plugin it depends on. </td>
    </tr>

  </table>

  <table>

    <tr> <td class="className" colspan="4"> <a name="SessionFolderRI"> SessionFolderRI </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The SessionFolderRI provides for a grouping of SessionRI objects.</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">STRUCTURAL</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Named by</td>
      <td colspan="2"> <a href="meta.html#dotName">dotName</a> </td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Must</td>
      <td> <a href="meta.html#dotName">dotName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#DotName">DotName</a> </td>
      <td> The dotName attribute is used to store dot separated names. </td>
    </tr>

  </table>

  <table>

    <tr> <td class="className" colspan="4"> <a name="SessionRI"> SessionRI </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The SessionRI represents an authenticated user session and is an important aspect of any serious application. All interactions are usually associated with a valid session and, in the case of the reference implementation of the Dark MAtter Protocol service are also associated with the handling of asynchronous message handling and events.</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">STRUCTURAL</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Wrapper</td>
      <td colspan="2">EXTENDED</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Named by</td>
      <td colspan="2"> <a href="meta.html#dotName">dotName</a> </td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Must</td>
      <td> <a href="meta.html#dotName">dotName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#DotName">DotName</a> </td>
      <td> The dotName attribute is used to store dot separated names. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmp.server.html#sessionHostRI">sessionHostRI</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> The name of the host associated with a session. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmp.server.html#sessionIDRI">sessionIDRI</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> The Tomcat unique session identifer. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmp.server.html#userRefRI">userRefRI</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="dmp.server.html#UserRI">UserRI</a> </td>
      <td> The user associated with a session. </td>
    </tr>

  </table>

  <table>

    <tr> <td class="className" colspan="4"> <a name="UserFolderRI"> UserFolderRI </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The UserFolderRI provides for a grouping of UserRI objects.</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">STRUCTURAL</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Named by</td>
      <td colspan="2"> <a href="meta.html#dotName">dotName</a> </td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Must</td>
      <td> <a href="meta.html#dotName">dotName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#DotName">DotName</a> </td>
      <td> The dotName attribute is used to store dot separated names. </td>
    </tr>

  </table>

  <table>

    <tr> <td class="className" colspan="4"> <a name="UserRI"> UserRI </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td>Description</td>
      <td colspan="2">The UserRI class provides a user representation for use with the  Reference Implementation (RI).</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Type</td>
      <td colspan="2">STRUCTURAL</td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td>Named by</td>
      <td colspan="2"> <a href="meta.html#dotName">dotName</a> </td>
    </tr>

  </table>

  <table>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Must</td>
      <td> <a href="meta.html#dotName">dotName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#DotName">DotName</a> </td>
      <td> The dotName attribute is used to store dot separated names. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmp.server.html#idRI">idRI</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#Integer">Integer</a> </td>
      <td> The unique id for the instance of something associated with the Reference Implementation (RI). </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmr.base.html#password">password</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> A user's password. </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label"> </td>
      <td> <a href="dmr.base.html#userName">userName</a> </td>
      <td class="valueType"> P SV </td>      <td> <a href="meta.html#String">String</a> </td>
      <td> The name of a user. </td>
    </tr>

  </table>

</div> <!-- classDetails -->

<div class="attributeDetails">

<h2> Attribute Details </h2>

  <table>

    <tr> <td class="className" colspan="3"> <a name="idRI"> idRI </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#Integer">Integer</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The unique id for the instance of something associated with the Reference Implementation (RI).</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="pluginClass"> pluginClass </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#String">String</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The fully qualified name of the class derived from DmpServletPlugin that implements a plugin's behaviour.</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="pluginName"> pluginName </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#CamelCaseName">CamelCaseName</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The globally unique name of a Dark Matter ServletPlugin.</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="runnable"> runnable </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#Boolean">Boolean</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>A flag to indicate if a plugin implements Runnable. If so, once all plugins have been initialized, the runnable plugins will be started.</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="sessionHostRI"> sessionHostRI </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#String">String</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The name of the host associated with a session.</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="sessionIDRI"> sessionIDRI </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#String">String</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The Tomcat unique session identifer.</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="startOrder"> startOrder </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="meta.html#Integer">Integer</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The order in which the plugins should be initialized and started. If no order is specified, we default to 5. If a plugin depends on data provided by another  plugin, it should have a later startOrder than the plugin it depends on.</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="useSchemaClass"> useSchemaClass </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P MV </div> <div class="attrType"> <a href="meta.html#String">String</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The fully qualified name of a schema class to be loaded on behalf of a plugin.</td>
    </tr>

    <tr> <td class="className" colspan="3"> <a name="userRefRI"> userRefRI </a> </td></tr>
    <tr>
      <td class="spacer"> </td>
      <td colspan="2"> <div class="valueType"> P SV </div> <div class="attrType"> <a href="dmp.server.html#UserRI">UserRI</a> </div> 
      </td>
    </tr>

    <tr>
      <td class="spacer"> </td>
      <td class="label">Description</td>
      <td>The user associated with a session.</td>
    </tr>

  </table>

</div> <!-- attributeDetails -->

    </div>

    <div id="sidebar">
        <a class="navLink" href="contacts.html"> contacts</a>
        <a class="navLink" href="dmg.html"> dmg</a>
        <a class="navLink" href="dmp.html"> dmp</a>
        <a class="navLink" href="dmp.server.html"> dmp.server</a>
        <a class="navLink" href="dmr.base.html"> dmr.base</a>
        <a class="navLink" href="dmr.ldap.html"> dmr.ldap</a>
        <a class="navLink" href="dmt.html"> dmt</a>
        <a class="navLink" href="dmv.html"> dmv</a>
        <a class="navLink" href="map.html"> map</a>
        <a class="navLink" href="meta.html"> meta</a>
        <a class="navLink" href="mvw.html"> mvw</a>
    </div>
  </div> <!-- main -->

  <div id="footer"> </div>

</body>

</html>
